CauseUnion
PackageAxial
Represents the cause of a failed workflow.
Specification
Kind
Union
Members
21
Examples
0
mapSignature
Cause.map mapper cause
thenCauseSignature
Cause.thenCause left right
bothSignature
Cause.both left right
tracedSignature
Cause.traced trace cause
untracedSignature
Cause.untraced cause
Summary
| Name | Signature | Synopsis |
|---|---|---|
| Union cases | ||
| IsThen | this.IsThen | No description available. |
| IsTraced | this.IsTraced | No description available. |
| IsFail | this.IsFail | No description available. |
| IsInterrupt | this.IsInterrupt | No description available. |
| IsBoth | this.IsBoth | No description available. |
| IsDie | this.IsDie | No description available. |
| Fail | Fail 'error | An expected domain-specific failure. |
| Die | Die exn | An unexpected defect or panic (e.g., an exception). |
| Interrupt | Interrupt | An administrative signal to stop the workflow (e.g., cancellation). |
| Then | Then(Cause<'error>, Cause<'error>) | Two causes happened sequentially; the left cause happened before the right cause. |
| Both | Both(Cause<'error>, Cause<'error>) | Two causes happened concurrently; neither cause is ordered before the other. |
| Traced | Traced(Cause<'error>, trace) | A cause annotated with diagnostic trace text. |
| Operations | ||
| map | Cause.map mapper cause | Transforms the error value of a failure cause using the provided function. |
| thenCause | Cause.thenCause left right | Combines causes that happened sequentially. |
| both | Cause.both left right | Combines causes that happened concurrently. |
| traced | Cause.traced trace cause | Attaches diagnostic trace text to a cause. |
| untraced | Cause.untraced cause | Removes trace text from the top of a cause, returning the cause it annotates. |
| failures | Cause.failures cause | Returns every typed failure value contained in a cause tree. |
| defects | Cause.defects cause | Returns every defect exception contained in a cause tree. |
| isInterrupted | Cause.isInterrupted cause | Returns whether the cause tree contains an interruption signal. |
| prettyPrint | Cause.prettyPrint formatError cause | Pretty prints a cause tree for diagnostics. |